Skip to content

Instantly share code, notes, and snippets.

@frague59
Created February 10, 2021 10:27
Show Gist options
  • Save frague59/128aa913ef08e690fb11afbfabef2744 to your computer and use it in GitHub Desktop.
Save frague59/128aa913ef08e690fb11afbfabef2744 to your computer and use it in GitHub Desktop.
Print management applicationschema
openapi: 3.0.3
info:
title: print-openapi
version: 0.9.25
description: Print application API with an OpenAPI interface
contact:
name: François GUÉRIN
email: [email protected]
url: https://gitlab.ville.tg/fguerin/print-openapi-client
paths:
/api-schema/:
get:
operationId: api_schema_retrieve
description: |-
OpenApi3 schema for this API. Format can be selected via content negotiation.
- YAML: application/vnd.oai.openapi
- JSON: application/vnd.oai.openapi+json
parameters:
- in: query
name: format
schema:
type: string
enum:
- json
- yaml
- in: query
name: lang
schema:
type: string
enum:
- fr
tags:
- api-schema
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/vnd.oai.openapi:
schema:
type: object
additionalProperties: {}
application/yaml:
schema:
type: object
additionalProperties: {}
application/vnd.oai.openapi+json:
schema:
type: object
additionalProperties: {}
application/json:
schema:
type: object
additionalProperties: {}
description: ''
/api-token-auth/:
post:
operationId: api_token_auth_create
description: |-
API View that receives a POST with a user's username and password.
Returns a JSON Web Token that can be used for authenticated requests.
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- api-token-auth
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JSONWebTokenRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/JSONWebTokenRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/JSONWebTokenRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JSONWebToken'
application/javascript:
schema:
$ref: '#/components/schemas/JSONWebToken'
text/html:
schema:
$ref: '#/components/schemas/JSONWebToken'
description: ''
/api-token-auth/refresh/:
post:
operationId: api_token_auth_refresh_create
description: |-
API View that returns a refreshed token (with new expiration) based on
existing token
If 'orig_iat' field (original issued-at-time) is found, will first check
if it's within expiration window, then copy it to the new token
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- api-token-auth
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RefreshJSONWebTokenRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/RefreshJSONWebTokenRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/RefreshJSONWebTokenRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RefreshJSONWebToken'
application/javascript:
schema:
$ref: '#/components/schemas/RefreshJSONWebToken'
text/html:
schema:
$ref: '#/components/schemas/RefreshJSONWebToken'
description: ''
/api-token-auth/verify/:
post:
operationId: api_token_auth_verify_create
description: |-
API View that checks the veracity of a token, returning the token if it
is valid.
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- api-token-auth
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyJSONWebTokenRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/VerifyJSONWebTokenRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/VerifyJSONWebTokenRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyJSONWebToken'
application/javascript:
schema:
$ref: '#/components/schemas/VerifyJSONWebToken'
text/html:
schema:
$ref: '#/components/schemas/VerifyJSONWebToken'
description: ''
/printflow/api/finish_folding/:
get:
operationId: printflow_api_finish_folding_list
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: query
name: id
schema:
type: integer
- in: query
name: label
schema:
type: string
- in: query
name: label__icontains
schema:
type: string
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedFinishFoldingList'
application/javascript:
schema:
$ref: '#/components/schemas/PaginatedFinishFoldingList'
text/html:
schema:
$ref: '#/components/schemas/PaginatedFinishFoldingList'
description: ''
post:
operationId: printflow_api_finish_folding_create
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FinishFoldingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FinishFoldingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/FinishFoldingRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishFolding'
application/javascript:
schema:
$ref: '#/components/schemas/FinishFolding'
text/html:
schema:
$ref: '#/components/schemas/FinishFolding'
description: ''
/printflow/api/finish_folding/{id}/:
get:
operationId: printflow_api_finish_folding_retrieve
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : pliage.'
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishFolding'
application/javascript:
schema:
$ref: '#/components/schemas/FinishFolding'
text/html:
schema:
$ref: '#/components/schemas/FinishFolding'
description: ''
put:
operationId: printflow_api_finish_folding_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : pliage.'
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FinishFoldingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FinishFoldingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/FinishFoldingRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishFolding'
application/javascript:
schema:
$ref: '#/components/schemas/FinishFolding'
text/html:
schema:
$ref: '#/components/schemas/FinishFolding'
description: ''
patch:
operationId: printflow_api_finish_folding_partial_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : pliage.'
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedFinishFoldingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedFinishFoldingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedFinishFoldingRequest'
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishFolding'
application/javascript:
schema:
$ref: '#/components/schemas/FinishFolding'
text/html:
schema:
$ref: '#/components/schemas/FinishFolding'
description: ''
delete:
operationId: printflow_api_finish_folding_destroy
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : pliage.'
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'204':
description: No response body
/printflow/api/finish_grooving/:
get:
operationId: printflow_api_finish_grooving_list
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: query
name: id
schema:
type: integer
- in: query
name: label
schema:
type: string
- in: query
name: label__icontains
schema:
type: string
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedFinishGroovingList'
application/javascript:
schema:
$ref: '#/components/schemas/PaginatedFinishGroovingList'
text/html:
schema:
$ref: '#/components/schemas/PaginatedFinishGroovingList'
description: ''
post:
operationId: printflow_api_finish_grooving_create
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FinishGroovingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FinishGroovingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/FinishGroovingRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishGrooving'
application/javascript:
schema:
$ref: '#/components/schemas/FinishGrooving'
text/html:
schema:
$ref: '#/components/schemas/FinishGrooving'
description: ''
/printflow/api/finish_grooving/{id}/:
get:
operationId: printflow_api_finish_grooving_retrieve
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : rainage.'
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishGrooving'
application/javascript:
schema:
$ref: '#/components/schemas/FinishGrooving'
text/html:
schema:
$ref: '#/components/schemas/FinishGrooving'
description: ''
put:
operationId: printflow_api_finish_grooving_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : rainage.'
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FinishGroovingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FinishGroovingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/FinishGroovingRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishGrooving'
application/javascript:
schema:
$ref: '#/components/schemas/FinishGrooving'
text/html:
schema:
$ref: '#/components/schemas/FinishGrooving'
description: ''
patch:
operationId: printflow_api_finish_grooving_partial_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : rainage.'
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedFinishGroovingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedFinishGroovingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedFinishGroovingRequest'
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishGrooving'
application/javascript:
schema:
$ref: '#/components/schemas/FinishGrooving'
text/html:
schema:
$ref: '#/components/schemas/FinishGrooving'
description: ''
delete:
operationId: printflow_api_finish_grooving_destroy
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : rainage.'
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'204':
description: No response body
/printflow/api/finish_option/:
get:
operationId: printflow_api_finish_option_list
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: query
name: id
schema:
type: integer
- in: query
name: label
schema:
type: string
- in: query
name: label__icontains
schema:
type: string
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedFinishOptionList'
application/javascript:
schema:
$ref: '#/components/schemas/PaginatedFinishOptionList'
text/html:
schema:
$ref: '#/components/schemas/PaginatedFinishOptionList'
description: ''
post:
operationId: printflow_api_finish_option_create
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FinishOptionRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FinishOptionRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/FinishOptionRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishOption'
application/javascript:
schema:
$ref: '#/components/schemas/FinishOption'
text/html:
schema:
$ref: '#/components/schemas/FinishOption'
description: ''
/printflow/api/finish_option/{id}/:
get:
operationId: printflow_api_finish_option_retrieve
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : options.'
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishOption'
application/javascript:
schema:
$ref: '#/components/schemas/FinishOption'
text/html:
schema:
$ref: '#/components/schemas/FinishOption'
description: ''
put:
operationId: printflow_api_finish_option_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : options.'
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FinishOptionRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FinishOptionRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/FinishOptionRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishOption'
application/javascript:
schema:
$ref: '#/components/schemas/FinishOption'
text/html:
schema:
$ref: '#/components/schemas/FinishOption'
description: ''
patch:
operationId: printflow_api_finish_option_partial_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : options.'
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedFinishOptionRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedFinishOptionRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedFinishOptionRequest'
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishOption'
application/javascript:
schema:
$ref: '#/components/schemas/FinishOption'
text/html:
schema:
$ref: '#/components/schemas/FinishOption'
description: ''
delete:
operationId: printflow_api_finish_option_destroy
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : options.'
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'204':
description: No response body
/printflow/api/finish_stapling/:
get:
operationId: printflow_api_finish_stapling_list
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: query
name: id
schema:
type: integer
- in: query
name: label
schema:
type: string
- in: query
name: label__icontains
schema:
type: string
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedFinishStaplingList'
application/javascript:
schema:
$ref: '#/components/schemas/PaginatedFinishStaplingList'
text/html:
schema:
$ref: '#/components/schemas/PaginatedFinishStaplingList'
description: ''
post:
operationId: printflow_api_finish_stapling_create
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FinishStaplingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FinishStaplingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/FinishStaplingRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishStapling'
application/javascript:
schema:
$ref: '#/components/schemas/FinishStapling'
text/html:
schema:
$ref: '#/components/schemas/FinishStapling'
description: ''
/printflow/api/finish_stapling/{id}/:
get:
operationId: printflow_api_finish_stapling_retrieve
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : agrafage.'
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishStapling'
application/javascript:
schema:
$ref: '#/components/schemas/FinishStapling'
text/html:
schema:
$ref: '#/components/schemas/FinishStapling'
description: ''
put:
operationId: printflow_api_finish_stapling_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : agrafage.'
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FinishStaplingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FinishStaplingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/FinishStaplingRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishStapling'
application/javascript:
schema:
$ref: '#/components/schemas/FinishStapling'
text/html:
schema:
$ref: '#/components/schemas/FinishStapling'
description: ''
patch:
operationId: printflow_api_finish_stapling_partial_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : agrafage.'
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedFinishStaplingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedFinishStaplingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedFinishStaplingRequest'
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinishStapling'
application/javascript:
schema:
$ref: '#/components/schemas/FinishStapling'
text/html:
schema:
$ref: '#/components/schemas/FinishStapling'
description: ''
delete:
operationId: printflow_api_finish_stapling_destroy
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: 'A unique integer value identifying this Finition : agrafage.'
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'204':
description: No response body
/printflow/api/job/:
get:
operationId: printflow_api_job_list
description: API View to list :class:`printflow.models.projects.PrintJob` instances
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: project
schema:
type: integer
- in: query
name: title
schema:
type: string
- in: query
name: title__icontains
schema:
type: string
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedPrintJobList'
application/javascript:
schema:
$ref: '#/components/schemas/PaginatedPrintJobList'
text/html:
schema:
$ref: '#/components/schemas/PaginatedPrintJobList'
description: ''
/printflow/api/job/{id}/:
get:
operationId: printflow_api_job_retrieve
description: API View to display a single :class:`printflow.models.projects.PrintJob`
instances
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintJob'
application/javascript:
schema:
$ref: '#/components/schemas/PrintJob'
text/html:
schema:
$ref: '#/components/schemas/PrintJob'
description: ''
/printflow/api/job/{id}/update/:
put:
operationId: printflow_api_job_update_update
description: API View to update :class:`printflow.models.projects.PrintJob`
instance
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrintJobCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PrintJobCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PrintJobCreateRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintJobCreate'
application/javascript:
schema:
$ref: '#/components/schemas/PrintJobCreate'
text/html:
schema:
$ref: '#/components/schemas/PrintJobCreate'
description: ''
patch:
operationId: printflow_api_job_update_partial_update
description: API View to update :class:`printflow.models.projects.PrintJob`
instance
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedPrintJobCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedPrintJobCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedPrintJobCreateRequest'
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintJobCreate'
application/javascript:
schema:
$ref: '#/components/schemas/PrintJobCreate'
text/html:
schema:
$ref: '#/components/schemas/PrintJobCreate'
description: ''
/printflow/api/job/add/:
post:
operationId: printflow_api_job_add_create
description: API View to create :class:`printflow.models.projects.PrintJob`
instance
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrintJobCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PrintJobCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PrintJobCreateRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintJobCreate'
application/javascript:
schema:
$ref: '#/components/schemas/PrintJobCreate'
text/html:
schema:
$ref: '#/components/schemas/PrintJobCreate'
description: ''
/printflow/api/job_file/:
get:
operationId: printflow_api_job_file_list
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: query
name: id
schema:
type: integer
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: print_job
schema:
type: integer
- in: query
name: title
schema:
type: string
- in: query
name: title__icontains
schema:
type: string
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedPrintJobFileList'
application/javascript:
schema:
$ref: '#/components/schemas/PaginatedPrintJobFileList'
text/html:
schema:
$ref: '#/components/schemas/PaginatedPrintJobFileList'
description: ''
/printflow/api/job_file/{id}/:
get:
operationId: printflow_api_job_file_retrieve
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintJobFile'
application/javascript:
schema:
$ref: '#/components/schemas/PrintJobFile'
text/html:
schema:
$ref: '#/components/schemas/PrintJobFile'
description: ''
/printflow/api/job_file/{id}/update/:
put:
operationId: printflow_api_job_file_update_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrintJobFileCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PrintJobFileCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PrintJobFileCreateRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintJobFileCreate'
application/javascript:
schema:
$ref: '#/components/schemas/PrintJobFileCreate'
text/html:
schema:
$ref: '#/components/schemas/PrintJobFileCreate'
description: ''
patch:
operationId: printflow_api_job_file_update_partial_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedPrintJobFileCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedPrintJobFileCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedPrintJobFileCreateRequest'
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintJobFileCreate'
application/javascript:
schema:
$ref: '#/components/schemas/PrintJobFileCreate'
text/html:
schema:
$ref: '#/components/schemas/PrintJobFileCreate'
description: ''
/printflow/api/job_file/add/:
post:
operationId: printflow_api_job_file_add_create
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrintJobFileCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PrintJobFileCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PrintJobFileCreateRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintJobFileCreate'
application/javascript:
schema:
$ref: '#/components/schemas/PrintJobFileCreate'
text/html:
schema:
$ref: '#/components/schemas/PrintJobFileCreate'
description: ''
/printflow/api/job_type/:
get:
operationId: printflow_api_job_type_list
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: query
name: id
schema:
type: integer
- in: query
name: label
schema:
type: string
- in: query
name: label__icontains
schema:
type: string
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedJobTypeList'
application/javascript:
schema:
$ref: '#/components/schemas/PaginatedJobTypeList'
text/html:
schema:
$ref: '#/components/schemas/PaginatedJobTypeList'
description: ''
post:
operationId: printflow_api_job_type_create
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobTypeRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/JobTypeRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/JobTypeRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/JobType'
application/javascript:
schema:
$ref: '#/components/schemas/JobType'
text/html:
schema:
$ref: '#/components/schemas/JobType'
description: ''
/printflow/api/job_type/{id}/:
get:
operationId: printflow_api_job_type_retrieve
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Type de travail.
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JobType'
application/javascript:
schema:
$ref: '#/components/schemas/JobType'
text/html:
schema:
$ref: '#/components/schemas/JobType'
description: ''
put:
operationId: printflow_api_job_type_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Type de travail.
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobTypeRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/JobTypeRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/JobTypeRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JobType'
application/javascript:
schema:
$ref: '#/components/schemas/JobType'
text/html:
schema:
$ref: '#/components/schemas/JobType'
description: ''
patch:
operationId: printflow_api_job_type_partial_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Type de travail.
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedJobTypeRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedJobTypeRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedJobTypeRequest'
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JobType'
application/javascript:
schema:
$ref: '#/components/schemas/JobType'
text/html:
schema:
$ref: '#/components/schemas/JobType'
description: ''
delete:
operationId: printflow_api_job_type_destroy
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Type de travail.
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'204':
description: No response body
/printflow/api/paper_color/:
get:
operationId: printflow_api_paper_color_list
description: ''
parameters:
- in: query
name: available_paper_types
schema:
type: array
items:
type: integer
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: query
name: label
schema:
type: string
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedPaperColorList'
application/javascript:
schema:
$ref: '#/components/schemas/PaginatedPaperColorList'
text/html:
schema:
$ref: '#/components/schemas/PaginatedPaperColorList'
description: ''
post:
operationId: printflow_api_paper_color_create
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaperColorRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PaperColorRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PaperColorRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PaperColor'
application/javascript:
schema:
$ref: '#/components/schemas/PaperColor'
text/html:
schema:
$ref: '#/components/schemas/PaperColor'
description: ''
/printflow/api/paper_color/{id}/:
get:
operationId: printflow_api_paper_color_retrieve
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Couleur de papier.
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaperColor'
application/javascript:
schema:
$ref: '#/components/schemas/PaperColor'
text/html:
schema:
$ref: '#/components/schemas/PaperColor'
description: ''
put:
operationId: printflow_api_paper_color_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Couleur de papier.
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaperColorRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PaperColorRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PaperColorRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaperColor'
application/javascript:
schema:
$ref: '#/components/schemas/PaperColor'
text/html:
schema:
$ref: '#/components/schemas/PaperColor'
description: ''
patch:
operationId: printflow_api_paper_color_partial_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Couleur de papier.
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedPaperColorRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedPaperColorRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedPaperColorRequest'
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaperColor'
application/javascript:
schema:
$ref: '#/components/schemas/PaperColor'
text/html:
schema:
$ref: '#/components/schemas/PaperColor'
description: ''
delete:
operationId: printflow_api_paper_color_destroy
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Couleur de papier.
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'204':
description: No response body
/printflow/api/paper_size/:
get:
operationId: printflow_api_paper_size_list
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: query
name: height__gte
schema:
type: string
format: decimal
maximum: 10000
minimum: -10000
description: En centimètres
- in: query
name: height__lte
schema:
type: string
format: decimal
maximum: 10000
minimum: -10000
description: En centimètres
- in: query
name: id
schema:
type: integer
- in: query
name: label
schema:
type: string
- in: query
name: label__icontains
schema:
type: string
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: width__gte
schema:
type: string
format: decimal
maximum: 10000
minimum: -10000
description: En centimètres
- in: query
name: width__lte
schema:
type: string
format: decimal
maximum: 10000
minimum: -10000
description: En centimètres
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedPaperSizeList'
application/javascript:
schema:
$ref: '#/components/schemas/PaginatedPaperSizeList'
text/html:
schema:
$ref: '#/components/schemas/PaginatedPaperSizeList'
description: ''
post:
operationId: printflow_api_paper_size_create
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaperSizeRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PaperSizeRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PaperSizeRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PaperSize'
application/javascript:
schema:
$ref: '#/components/schemas/PaperSize'
text/html:
schema:
$ref: '#/components/schemas/PaperSize'
description: ''
/printflow/api/paper_size/{id}/:
get:
operationId: printflow_api_paper_size_retrieve
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Format de papier.
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaperSize'
application/javascript:
schema:
$ref: '#/components/schemas/PaperSize'
text/html:
schema:
$ref: '#/components/schemas/PaperSize'
description: ''
put:
operationId: printflow_api_paper_size_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Format de papier.
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaperSizeRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PaperSizeRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PaperSizeRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaperSize'
application/javascript:
schema:
$ref: '#/components/schemas/PaperSize'
text/html:
schema:
$ref: '#/components/schemas/PaperSize'
description: ''
patch:
operationId: printflow_api_paper_size_partial_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Format de papier.
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedPaperSizeRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedPaperSizeRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedPaperSizeRequest'
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaperSize'
application/javascript:
schema:
$ref: '#/components/schemas/PaperSize'
text/html:
schema:
$ref: '#/components/schemas/PaperSize'
description: ''
delete:
operationId: printflow_api_paper_size_destroy
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Format de papier.
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'204':
description: No response body
/printflow/api/paper_type/:
get:
operationId: printflow_api_paper_type_list
description: ''
parameters:
- in: query
name: extra
schema:
type: string
nullable: true
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: weight
schema:
type: integer
maximum: 4294967295
format: int64
description: En g/m²
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedPaperTypeList'
application/javascript:
schema:
$ref: '#/components/schemas/PaginatedPaperTypeList'
text/html:
schema:
$ref: '#/components/schemas/PaginatedPaperTypeList'
description: ''
post:
operationId: printflow_api_paper_type_create
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaperTypeRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PaperTypeRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PaperTypeRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PaperType'
application/javascript:
schema:
$ref: '#/components/schemas/PaperType'
text/html:
schema:
$ref: '#/components/schemas/PaperType'
description: ''
/printflow/api/paper_type/{id}/:
get:
operationId: printflow_api_paper_type_retrieve
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Grammage du papier.
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaperType'
application/javascript:
schema:
$ref: '#/components/schemas/PaperType'
text/html:
schema:
$ref: '#/components/schemas/PaperType'
description: ''
put:
operationId: printflow_api_paper_type_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Grammage du papier.
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaperTypeRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PaperTypeRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PaperTypeRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaperType'
application/javascript:
schema:
$ref: '#/components/schemas/PaperType'
text/html:
schema:
$ref: '#/components/schemas/PaperType'
description: ''
patch:
operationId: printflow_api_paper_type_partial_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Grammage du papier.
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedPaperTypeRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedPaperTypeRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedPaperTypeRequest'
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaperType'
application/javascript:
schema:
$ref: '#/components/schemas/PaperType'
text/html:
schema:
$ref: '#/components/schemas/PaperType'
description: ''
delete:
operationId: printflow_api_paper_type_destroy
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Grammage du papier.
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'204':
description: No response body
/printflow/api/project/:
get:
operationId: printflow_api_project_list
description: ''
parameters:
- in: query
name: created_at
schema:
type: string
format: date-time
- in: query
name: created_by
schema:
type: integer
- in: query
name: due_at
schema:
type: string
format: date-time
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: query
name: hierarchy
schema:
type: integer
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: title
schema:
type: string
- in: query
name: validator
schema:
type: integer
nullable: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedPrintProjectList'
application/javascript:
schema:
$ref: '#/components/schemas/PaginatedPrintProjectList'
text/html:
schema:
$ref: '#/components/schemas/PaginatedPrintProjectList'
description: ''
/printflow/api/project/{id}/:
get:
operationId: printflow_api_project_retrieve
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintProject'
application/javascript:
schema:
$ref: '#/components/schemas/PrintProject'
text/html:
schema:
$ref: '#/components/schemas/PrintProject'
description: ''
/printflow/api/project/{id}/update/:
put:
operationId: printflow_api_project_update_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrintProjectRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PrintProjectRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PrintProjectRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintProject'
application/javascript:
schema:
$ref: '#/components/schemas/PrintProject'
text/html:
schema:
$ref: '#/components/schemas/PrintProject'
description: ''
patch:
operationId: printflow_api_project_update_partial_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedPrintProjectRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedPrintProjectRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedPrintProjectRequest'
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintProject'
application/javascript:
schema:
$ref: '#/components/schemas/PrintProject'
text/html:
schema:
$ref: '#/components/schemas/PrintProject'
description: ''
/printflow/api/project/add/:
post:
operationId: printflow_api_project_add_create
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrintProjectCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PrintProjectCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PrintProjectCreateRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintProjectCreate'
application/javascript:
schema:
$ref: '#/components/schemas/PrintProjectCreate'
text/html:
schema:
$ref: '#/components/schemas/PrintProjectCreate'
description: ''
/printflow/api/user_profile/:
get:
operationId: printflow_api_user_profile_list
description: ''
parameters:
- in: query
name: can_validate
schema:
type: boolean
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: query
name: hierarchies
schema:
type: array
items:
type: integer
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: user
schema:
type: integer
- in: query
name: username
schema:
type: string
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedProfileList'
application/javascript:
schema:
$ref: '#/components/schemas/PaginatedProfileList'
text/html:
schema:
$ref: '#/components/schemas/PaginatedProfileList'
description: ''
post:
operationId: printflow_api_user_profile_create
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ProfileRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ProfileRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
application/javascript:
schema:
$ref: '#/components/schemas/Profile'
text/html:
schema:
$ref: '#/components/schemas/Profile'
description: ''
/printflow/api/user_profile/{id}/:
get:
operationId: printflow_api_user_profile_retrieve
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Profil utilisateur.
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
application/javascript:
schema:
$ref: '#/components/schemas/Profile'
text/html:
schema:
$ref: '#/components/schemas/Profile'
description: ''
put:
operationId: printflow_api_user_profile_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Profil utilisateur.
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ProfileRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ProfileRequest'
required: true
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
application/javascript:
schema:
$ref: '#/components/schemas/Profile'
text/html:
schema:
$ref: '#/components/schemas/Profile'
description: ''
patch:
operationId: printflow_api_user_profile_partial_update
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Profil utilisateur.
required: true
tags:
- printflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedProfileRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedProfileRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedProfileRequest'
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
application/javascript:
schema:
$ref: '#/components/schemas/Profile'
text/html:
schema:
$ref: '#/components/schemas/Profile'
description: ''
delete:
operationId: printflow_api_user_profile_destroy
description: ''
parameters:
- in: query
name: format
schema:
type: string
enum:
- admin
- json
- jsonp
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Profil utilisateur.
required: true
tags:
- printflow
security:
- jwtAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'204':
description: No response body
components:
schemas:
FinishFolding:
type: object
properties:
pk:
type: integer
readOnly: true
label:
type: string
maxLength: 255
required:
- label
FinishFoldingRequest:
type: object
properties:
label:
type: string
maxLength: 255
required:
- label
FinishGrooving:
type: object
properties:
pk:
type: integer
readOnly: true
label:
type: string
maxLength: 255
required:
- label
FinishGroovingRequest:
type: object
properties:
label:
type: string
maxLength: 255
required:
- label
FinishOption:
type: object
properties:
pk:
type: integer
readOnly: true
label:
type: string
maxLength: 255
required:
- label
FinishOptionRequest:
type: object
properties:
label:
type: string
maxLength: 255
required:
- label
FinishStapling:
type: object
properties:
pk:
type: integer
readOnly: true
label:
type: string
maxLength: 255
required:
- label
FinishStaplingRequest:
type: object
properties:
label:
type: string
maxLength: 255
required:
- label
Hierarchy:
type: object
description: Serialization a :class:`printflow.models.Hierarchy` items.
properties:
pk:
type: integer
readOnly: true
name:
type: string
maxLength: 255
drf_url:
type: string
format: uri
nullable: true
maxLength: 200
public_url:
type: string
format: uri
nullable: true
maxLength: 200
can_create_project:
type: boolean
required:
- name
HierarchyRequest:
type: object
description: Serialization a :class:`printflow.models.Hierarchy` items.
properties:
name:
type: string
maxLength: 255
drf_url:
type: string
format: uri
nullable: true
maxLength: 200
public_url:
type: string
format: uri
nullable: true
maxLength: 200
can_create_project:
type: boolean
required:
- name
JSONWebToken:
type: object
description: |-
Serializer class used to validate a username and password.
'username' is identified by the custom UserModel.USERNAME_FIELD.
Returns a JSON Web Token that can be used to authenticate later calls.
properties:
username:
type: string
required:
- username
JSONWebTokenRequest:
type: object
description: |-
Serializer class used to validate a username and password.
'username' is identified by the custom UserModel.USERNAME_FIELD.
Returns a JSON Web Token that can be used to authenticate later calls.
properties:
username:
type: string
password:
type: string
writeOnly: true
required:
- password
- username
JobType:
type: object
description: Serialization for :class:`printflow.models.projects.JobType` items.
properties:
pk:
type: integer
readOnly: true
label:
type: string
maxLength: 255
updated_by:
type: integer
readOnly: true
created_by:
type: integer
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
required:
- label
JobTypeRequest:
type: object
description: Serialization for :class:`printflow.models.projects.JobType` items.
properties:
label:
type: string
maxLength: 255
required:
- label
PaginatedFinishFoldingList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/FinishFolding'
PaginatedFinishGroovingList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/FinishGrooving'
PaginatedFinishOptionList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/FinishOption'
PaginatedFinishStaplingList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/FinishStapling'
PaginatedJobTypeList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/JobType'
PaginatedPaperColorList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/PaperColor'
PaginatedPaperSizeList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/PaperSize'
PaginatedPaperTypeList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/PaperType'
PaginatedPrintJobFileList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/PrintJobFile'
PaginatedPrintJobList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/PrintJob'
PaginatedPrintProjectList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/PrintProject'
PaginatedProfileList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/Profile'
PaperColor:
type: object
description: Serialization of :class:`printflow.models.paper.PaperColor` items.
properties:
pk:
type: integer
readOnly: true
label:
type: string
maxLength: 255
available_paper_types:
type: array
items:
$ref: '#/components/schemas/PaperType'
readOnly: true
required:
- label
PaperColorRequest:
type: object
description: Serialization of :class:`printflow.models.paper.PaperColor` items.
properties:
label:
type: string
maxLength: 255
required:
- label
PaperSize:
type: object
properties:
pk:
type: integer
readOnly: true
label:
type: string
maxLength: 255
width:
type: string
format: decimal
maximum: 10000
minimum: -10000
description: En centimètres
height:
type: string
format: decimal
maximum: 10000
minimum: -10000
description: En centimètres
required:
- height
- label
- width
PaperSizeRequest:
type: object
properties:
label:
type: string
maxLength: 255
width:
type: string
format: decimal
maximum: 10000
minimum: -10000
description: En centimètres
height:
type: string
format: decimal
maximum: 10000
minimum: -10000
description: En centimètres
required:
- height
- label
- width
PaperType:
type: object
description: Serialization of :class:`printflow.models.paper.PaperType` items.
properties:
pk:
type: integer
readOnly: true
weight:
type: integer
maximum: 4294967295
format: int64
description: En g/m²
minimum: 0
extra:
type: string
nullable: true
maxLength: 255
required:
- weight
PaperTypeRequest:
type: object
description: Serialization of :class:`printflow.models.paper.PaperType` items.
properties:
weight:
type: integer
maximum: 4294967295
format: int64
description: En g/m²
minimum: 0
extra:
type: string
nullable: true
maxLength: 255
required:
- weight
PatchedFinishFoldingRequest:
type: object
properties:
label:
type: string
maxLength: 255
PatchedFinishGroovingRequest:
type: object
properties:
label:
type: string
maxLength: 255
PatchedFinishOptionRequest:
type: object
properties:
label:
type: string
maxLength: 255
PatchedFinishStaplingRequest:
type: object
properties:
label:
type: string
maxLength: 255
PatchedJobTypeRequest:
type: object
description: Serialization for :class:`printflow.models.projects.JobType` items.
properties:
label:
type: string
maxLength: 255
PatchedPaperColorRequest:
type: object
description: Serialization of :class:`printflow.models.paper.PaperColor` items.
properties:
label:
type: string
maxLength: 255
PatchedPaperSizeRequest:
type: object
properties:
label:
type: string
maxLength: 255
width:
type: string
format: decimal
maximum: 10000
minimum: -10000
description: En centimètres
height:
type: string
format: decimal
maximum: 10000
minimum: -10000
description: En centimètres
PatchedPaperTypeRequest:
type: object
description: Serialization of :class:`printflow.models.paper.PaperType` items.
properties:
weight:
type: integer
maximum: 4294967295
format: int64
description: En g/m²
minimum: 0
extra:
type: string
nullable: true
maxLength: 255
PatchedPrintJobCreateRequest:
type: object
properties:
title:
type: string
maxLength: 255
description:
type: string
nullable: true
project:
type: integer
due_at:
type: string
format: date-time
nullable: true
document_type:
type: integer
nullable: true
document_type_other:
type: string
nullable: true
maxLength: 255
pages_count:
type: integer
maximum: 4294967295
format: int64
minimum: 0
copies_count:
type: integer
maximum: 4294967295
format: int64
minimum: 0
both_sides:
type: boolean
paper_size:
type: integer
nullable: true
description: Si aucun type de papier n'est sélectionné, le choix est laissé
aux imprimeurs.
paper_size_other_width:
type: string
format: decimal
maximum: 10000
minimum: -10000
nullable: true
description: En centimètres
paper_size_other_height:
type: string
format: decimal
maximum: 10000
minimum: -10000
nullable: true
description: En centimètres
paper_type:
type: integer
nullable: true
paper_color:
type: integer
nullable: true
finish_stapling:
type: integer
nullable: true
finish_folding:
type: integer
nullable: true
finish_grooving:
type: integer
nullable: true
finish_options:
type: array
items:
type: integer
PatchedPrintJobFileCreateRequest:
type: object
properties:
print_job:
type: integer
title:
type: string
maxLength: 255
attachment:
type: string
format: binary
PatchedPrintProjectRequest:
type: object
description: Serialization for :class:`printflow.models.PrintProject` items.
properties:
title:
type: string
maxLength: 255
description:
type: string
nullable: true
hierarchy:
type: integer
validator:
type: integer
nullable: true
authorization_file:
type: string
format: binary
nullable: true
due_at:
type: string
format: date-time
delivered_at:
type: string
format: date-time
nullable: true
PatchedProfileRequest:
type: object
description: Serialization of :class:`printflow.models.userprofile.Profile`
items.
properties:
user:
$ref: '#/components/schemas/UserRequest'
hierarchies:
type: array
items:
$ref: '#/components/schemas/HierarchyRequest'
can_validate:
type: boolean
PrintJob:
type: object
description: Serialization for :class:`printflow.models.PrintJob` items.
properties:
pk:
type: integer
readOnly: true
title:
type: string
maxLength: 255
description:
type: string
nullable: true
project:
type: integer
due_at:
type: string
format: date-time
nullable: true
document_type:
type: integer
nullable: true
document_type_other:
type: string
nullable: true
maxLength: 255
total_sheets:
type: integer
readOnly: true
pages_count:
type: integer
maximum: 4294967295
format: int64
minimum: 0
copies_count:
type: integer
maximum: 4294967295
format: int64
minimum: 0
both_sides:
type: boolean
paper_size:
type: integer
nullable: true
description: Si aucun type de papier n'est sélectionné, le choix est laissé
aux imprimeurs.
paper_size_other_width:
type: string
format: decimal
maximum: 10000
minimum: -10000
nullable: true
description: En centimètres
paper_size_other_height:
type: string
format: decimal
maximum: 10000
minimum: -10000
nullable: true
description: En centimètres
paper_type:
type: integer
nullable: true
paper_color:
type: integer
nullable: true
finish_stapling:
type: integer
nullable: true
finish_folding:
type: integer
nullable: true
finish_grooving:
type: integer
nullable: true
finish_options:
type: array
items:
type: integer
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
created_by:
type: integer
readOnly: true
updated_by:
type: integer
readOnly: true
status:
type: string
maxLength: 50
required:
- project
- title
PrintJobCreate:
type: object
properties:
pk:
type: integer
readOnly: true
title:
type: string
maxLength: 255
description:
type: string
nullable: true
project:
type: integer
due_at:
type: string
format: date-time
nullable: true
document_type:
type: integer
nullable: true
document_type_other:
type: string
nullable: true
maxLength: 255
pages_count:
type: integer
maximum: 4294967295
format: int64
minimum: 0
copies_count:
type: integer
maximum: 4294967295
format: int64
minimum: 0
both_sides:
type: boolean
paper_size:
type: integer
nullable: true
description: Si aucun type de papier n'est sélectionné, le choix est laissé
aux imprimeurs.
paper_size_other_width:
type: string
format: decimal
maximum: 10000
minimum: -10000
nullable: true
description: En centimètres
paper_size_other_height:
type: string
format: decimal
maximum: 10000
minimum: -10000
nullable: true
description: En centimètres
paper_type:
type: integer
nullable: true
paper_color:
type: integer
nullable: true
finish_stapling:
type: integer
nullable: true
finish_folding:
type: integer
nullable: true
finish_grooving:
type: integer
nullable: true
finish_options:
type: array
items:
type: integer
required:
- project
- title
PrintJobCreateRequest:
type: object
properties:
title:
type: string
maxLength: 255
description:
type: string
nullable: true
project:
type: integer
due_at:
type: string
format: date-time
nullable: true
document_type:
type: integer
nullable: true
document_type_other:
type: string
nullable: true
maxLength: 255
pages_count:
type: integer
maximum: 4294967295
format: int64
minimum: 0
copies_count:
type: integer
maximum: 4294967295
format: int64
minimum: 0
both_sides:
type: boolean
paper_size:
type: integer
nullable: true
description: Si aucun type de papier n'est sélectionné, le choix est laissé
aux imprimeurs.
paper_size_other_width:
type: string
format: decimal
maximum: 10000
minimum: -10000
nullable: true
description: En centimètres
paper_size_other_height:
type: string
format: decimal
maximum: 10000
minimum: -10000
nullable: true
description: En centimètres
paper_type:
type: integer
nullable: true
paper_color:
type: integer
nullable: true
finish_stapling:
type: integer
nullable: true
finish_folding:
type: integer
nullable: true
finish_grooving:
type: integer
nullable: true
finish_options:
type: array
items:
type: integer
required:
- project
- title
PrintJobFile:
type: object
description: Serialization for :class:`printflow.models.projects.PrintJobFile`
items.
properties:
pk:
type: integer
readOnly: true
print_job:
type: integer
title:
type: string
maxLength: 255
attachment:
type: string
format: uri
updated_by:
type: integer
readOnly: true
created_by:
type: integer
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
required:
- attachment
- print_job
- title
PrintJobFileCreate:
type: object
properties:
pk:
type: integer
readOnly: true
print_job:
type: integer
title:
type: string
maxLength: 255
attachment:
type: string
format: uri
required:
- attachment
- print_job
- title
PrintJobFileCreateRequest:
type: object
properties:
print_job:
type: integer
title:
type: string
maxLength: 255
attachment:
type: string
format: binary
required:
- attachment
- print_job
- title
PrintProject:
type: object
description: Serialization for :class:`printflow.models.PrintProject` items.
properties:
pk:
type: integer
readOnly: true
title:
type: string
maxLength: 255
description:
type: string
nullable: true
hierarchy:
type: integer
validator:
type: integer
nullable: true
authorization_file:
type: string
format: uri
nullable: true
due_at:
type: string
format: date-time
delivered_at:
type: string
format: date-time
nullable: true
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
created_by:
type: integer
readOnly: true
updated_by:
type: integer
readOnly: true
status:
type: string
readOnly: true
required:
- due_at
- title
PrintProjectCreate:
type: object
properties:
pk:
type: integer
readOnly: true
title:
type: string
maxLength: 255
description:
type: string
nullable: true
hierarchy:
type: integer
validator:
type: integer
nullable: true
due_at:
type: string
format: date-time
required:
- due_at
- title
PrintProjectCreateRequest:
type: object
properties:
title:
type: string
maxLength: 255
description:
type: string
nullable: true
hierarchy:
type: integer
validator:
type: integer
nullable: true
due_at:
type: string
format: date-time
required:
- due_at
- title
PrintProjectRequest:
type: object
description: Serialization for :class:`printflow.models.PrintProject` items.
properties:
title:
type: string
maxLength: 255
description:
type: string
nullable: true
hierarchy:
type: integer
validator:
type: integer
nullable: true
authorization_file:
type: string
format: binary
nullable: true
due_at:
type: string
format: date-time
delivered_at:
type: string
format: date-time
nullable: true
required:
- due_at
- title
Profile:
type: object
description: Serialization of :class:`printflow.models.userprofile.Profile`
items.
properties:
pk:
type: integer
readOnly: true
user:
$ref: '#/components/schemas/User'
hierarchies:
type: array
items:
$ref: '#/components/schemas/Hierarchy'
can_validate:
type: boolean
required:
- hierarchies
- user
ProfileRequest:
type: object
description: Serialization of :class:`printflow.models.userprofile.Profile`
items.
properties:
user:
$ref: '#/components/schemas/UserRequest'
hierarchies:
type: array
items:
$ref: '#/components/schemas/HierarchyRequest'
can_validate:
type: boolean
required:
- hierarchies
- user
RefreshJSONWebToken:
type: object
description: Refresh an access token.
properties:
token:
type: string
required:
- token
RefreshJSONWebTokenRequest:
type: object
description: Refresh an access token.
properties:
token:
type: string
required:
- token
User:
type: object
description: Serialization for :class:`printflow.models.PrintProject` items.
properties:
pk:
type: integer
readOnly: true
username:
type: string
description: Requis. 150 caractères maximum. Uniquement des lettres, nombres
et les caractères « @ », « . », « + », « - » et « _ ».
pattern: ^[\w.@+-]+$
maxLength: 150
last_name:
type: string
maxLength: 150
first_name:
type: string
maxLength: 150
email:
type: string
format: email
maxLength: 254
is_superuser:
type: boolean
description: Précise que l’utilisateur possède toutes les permissions sans
les assigner explicitement.
is_staff:
type: boolean
description: Précise si l’utilisateur peut se connecter à ce site d'administration.
required:
- username
UserRequest:
type: object
description: Serialization for :class:`printflow.models.PrintProject` items.
properties:
username:
type: string
description: Requis. 150 caractères maximum. Uniquement des lettres, nombres
et les caractères « @ », « . », « + », « - » et « _ ».
pattern: ^[\w.@+-]+$
maxLength: 150
last_name:
type: string
maxLength: 150
first_name:
type: string
maxLength: 150
email:
type: string
format: email
maxLength: 254
is_superuser:
type: boolean
description: Précise que l’utilisateur possède toutes les permissions sans
les assigner explicitement.
is_staff:
type: boolean
description: Précise si l’utilisateur peut se connecter à ce site d'administration.
required:
- username
VerifyJSONWebToken:
type: object
description: Check the veracity of an access token.
properties:
token:
type: string
required:
- token
VerifyJSONWebTokenRequest:
type: object
description: Check the veracity of an access token.
properties:
token:
type: string
required:
- token
securitySchemes:
basicAuth:
type: http
scheme: basic
cookieAuth:
type: apiKey
in: cookie
name: Session
jwtAuth:
type: http
scheme: bearer
bearerFormat: Bearer
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment