swagger: "2.0" info: title: "" version: 0.0.1 host: localhost:80 consumes: - application/json - application/xml - application/gob produces: - application/json - application/xml - application/gob paths: /mail-address: get: tags: - MailAddresses summary: listMailAddresses MailAddresses operationId: MailAddresses#listMailAddresses parameters: - name: page in: query description: Page number required: false type: integer default: 1 minimum: 0 - name: limit in: query description: Number of items per page required: false type: integer default: 10 maximum: 100 minimum: 0 responses: "200": description: OK response. schema: $ref: '#/definitions/Maillist' schemes: - http post: tags: - MailAddresses summary: createMailAddress MailAddresses operationId: MailAddresses#createMailAddress parameters: - name: CreateMailAddressRequestBody in: body required: true schema: $ref: '#/definitions/MailPayload' required: - address responses: "201": description: Created response. schema: $ref: '#/definitions/Mail' required: - id - address - active - createdAt - updateAt schemes: - http /mail-address/{id}: get: tags: - MailAddresses summary: getMailAddresses MailAddresses description: Get mail address by ID operationId: MailAddresses#getMailAddresses parameters: - name: id in: path description: Unique mail ID required: true type: string responses: "200": description: OK response. schema: $ref: '#/definitions/Mail' required: - id - address - active - createdAt - updateAt "404": description: Not Found response. schema: $ref: '#/definitions/MailAddressesGetMailAddressesNotFoundResponseBody' schemes: - http put: tags: - MailAddresses summary: updateMailAddress MailAddresses operationId: MailAddresses#updateMailAddress parameters: - name: id in: path description: Unique mail ID required: true type: string - name: UpdateMailAddressRequestBody in: body required: true schema: $ref: '#/definitions/MailAddressesUpdateMailAddressRequestBody' required: - address - active responses: "200": description: OK response. "404": description: Not Found response. schema: $ref: '#/definitions/MailAddressesUpdateMailAddressNotFoundResponseBody' schemes: - http delete: tags: - MailAddresses summary: deleteMailAddress MailAddresses operationId: MailAddresses#deleteMailAddress parameters: - name: id in: path description: Unique mail ID required: true type: string responses: "204": description: No Content response. "404": description: Not Found response. schema: $ref: '#/definitions/MailAddressesDeleteMailAddressNotFoundResponseBody' schemes: - http /results: get: tags: - Result summary: listResults Result operationId: Result#listResults parameters: - name: page in: query description: Page number required: false type: integer default: 1 minimum: 0 - name: limit in: query description: Number of items per page required: false type: integer default: 10 maximum: 100 minimum: 0 responses: "200": description: OK response. schema: $ref: '#/definitions/Resultlist' schemes: - http post: tags: - Result summary: createResult Result operationId: Result#createResult parameters: - name: CreateResultRequestBody in: body required: true schema: $ref: '#/definitions/ResultPayload' responses: "201": description: Created response. schema: $ref: '#/definitions/Result' required: - id - status - createdAt - updateAt schemes: - http definitions: Mail: title: Mail type: object properties: active: type: boolean description: Status of email address default: true example: true address: type: string description: Address of user mail example: xw format: email minLength: 1 createdAt: type: string description: Created at date of mail example: Ipsam error facere facilis optio. id: type: string description: Unique mail ID example: Placeat beatae consequatur voluptas labore. updateAt: type: string description: Updated at date of mail example: Dicta iure necessitatibus quasi aut. description: Mail type example: active: true address: 8g9 createdAt: Qui qui deserunt nemo natus pariatur non. id: Dignissimos repellendus corporis. updateAt: Cumque quia quisquam aliquid quam consequatur accusamus. required: - id - address - active - createdAt - updateAt MailAddressesDeleteMailAddressNotFoundResponseBody: title: 'Mediatype identifier: application/vnd.goa.error; view=default' type: object properties: fault: type: boolean description: Is the error a server-side fault? example: true id: type: string description: ID is a unique identifier for this particular occurrence of the problem. example: 123abc message: type: string description: Message is a human-readable explanation specific to this occurrence of the problem. example: parameter 'p' must be an integer name: type: string description: Name is the name of this class of errors. example: bad_request temporary: type: boolean description: Is the error temporary? example: false timeout: type: boolean description: Is the error a timeout? example: false description: Mail address not found (default view) example: fault: false id: 123abc message: parameter 'p' must be an integer name: bad_request temporary: false timeout: false required: - name - id - message - temporary - timeout - fault MailAddressesGetMailAddressesNotFoundResponseBody: title: 'Mediatype identifier: application/vnd.goa.error; view=default' type: object properties: fault: type: boolean description: Is the error a server-side fault? example: false id: type: string description: ID is a unique identifier for this particular occurrence of the problem. example: 123abc message: type: string description: Message is a human-readable explanation specific to this occurrence of the problem. example: parameter 'p' must be an integer name: type: string description: Name is the name of this class of errors. example: bad_request temporary: type: boolean description: Is the error temporary? example: false timeout: type: boolean description: Is the error a timeout? example: true description: Mail address not found (default view) example: fault: false id: 123abc message: parameter 'p' must be an integer name: bad_request temporary: false timeout: false required: - name - id - message - temporary - timeout - fault MailAddressesUpdateMailAddressNotFoundResponseBody: title: 'Mediatype identifier: application/vnd.goa.error; view=default' type: object properties: fault: type: boolean description: Is the error a server-side fault? example: false id: type: string description: ID is a unique identifier for this particular occurrence of the problem. example: 123abc message: type: string description: Message is a human-readable explanation specific to this occurrence of the problem. example: parameter 'p' must be an integer name: type: string description: Name is the name of this class of errors. example: bad_request temporary: type: boolean description: Is the error temporary? example: true timeout: type: boolean description: Is the error a timeout? example: false description: Mail address not found (default view) example: fault: true id: 123abc message: parameter 'p' must be an integer name: bad_request temporary: false timeout: true required: - name - id - message - temporary - timeout - fault MailAddressesUpdateMailAddressRequestBody: title: MailAddressesUpdateMailAddressRequestBody type: object properties: active: type: boolean description: Status of email address default: true example: false address: type: string description: Address of user mail example: "3" format: email minLength: 1 example: active: true address: o1a required: - address - active MailPayload: title: MailPayload type: object properties: active: type: boolean description: Status of email address default: true example: true address: type: string description: Address of user mail example: sjn format: email minLength: 1 example: active: true address: em9 required: - address Maillist: title: 'Mediatype identifier: maillist; view=default' type: object properties: data: type: array items: $ref: '#/definitions/Mail' example: - active: false address: k createdAt: Necessitatibus harum aut fuga dolorem dolore. id: Autem optio vitae ducimus neque illum quod. updateAt: Ab deleniti dicta nam praesentium iure non. - active: false address: k createdAt: Necessitatibus harum aut fuga dolorem dolore. id: Autem optio vitae ducimus neque illum quod. updateAt: Ab deleniti dicta nam praesentium iure non. - active: false address: k createdAt: Necessitatibus harum aut fuga dolorem dolore. id: Autem optio vitae ducimus neque illum quod. updateAt: Ab deleniti dicta nam praesentium iure non. - active: false address: k createdAt: Necessitatibus harum aut fuga dolorem dolore. id: Autem optio vitae ducimus neque illum quod. updateAt: Ab deleniti dicta nam praesentium iure non. limit: type: integer description: Items per page example: 8879520672104091520 format: int64 page: type: integer description: Page number example: 1007158462382758187 format: int64 total: type: integer description: Total number of mails example: 8575113946938552447 format: int64 description: ListMailAddressesResponseBody result type (default view) example: data: - active: false address: k createdAt: Necessitatibus harum aut fuga dolorem dolore. id: Autem optio vitae ducimus neque illum quod. updateAt: Ab deleniti dicta nam praesentium iure non. - active: false address: k createdAt: Necessitatibus harum aut fuga dolorem dolore. id: Autem optio vitae ducimus neque illum quod. updateAt: Ab deleniti dicta nam praesentium iure non. - active: false address: k createdAt: Necessitatibus harum aut fuga dolorem dolore. id: Autem optio vitae ducimus neque illum quod. updateAt: Ab deleniti dicta nam praesentium iure non. limit: 9110688497955795089 page: 5656522343359333979 total: 850673698430259482 required: - data - page - limit - total Result: title: Result type: object properties: createdAt: type: string description: Created at date of scrape example: Harum culpa fugiat neque nam aut. id: type: string description: Unique result ID example: Saepe provident sit sed. status: type: string description: Status result of scrape example: AVAILABLE, NOT_AVAILABLE or TIMEOUT updateAt: type: string description: Updated at date of scrape example: Consequatur autem quasi quas. description: Result type example: createdAt: Maiores fugit veniam sed numquam eveniet eligendi. id: Sint voluptate facilis. status: AVAILABLE, NOT_AVAILABLE or TIMEOUT updateAt: Assumenda non cum corporis et. required: - id - status - createdAt - updateAt ResultPayload: title: ResultPayload type: object properties: status: type: string description: Status result of scrape example: AVAILABLE, NOT_AVAILABLE or TIMEOUT example: status: AVAILABLE, NOT_AVAILABLE or TIMEOUT Resultlist: title: 'Mediatype identifier: resultlist; view=default' type: object properties: data: type: array items: $ref: '#/definitions/Result' example: - createdAt: Et nihil eum aliquid. id: Corrupti adipisci. status: AVAILABLE, NOT_AVAILABLE or TIMEOUT updateAt: Eligendi numquam explicabo et et. - createdAt: Et nihil eum aliquid. id: Corrupti adipisci. status: AVAILABLE, NOT_AVAILABLE or TIMEOUT updateAt: Eligendi numquam explicabo et et. - createdAt: Et nihil eum aliquid. id: Corrupti adipisci. status: AVAILABLE, NOT_AVAILABLE or TIMEOUT updateAt: Eligendi numquam explicabo et et. limit: type: integer description: Items per page example: 2949390883894271126 format: int64 page: type: integer description: Page number example: 3372673253436973395 format: int64 total: type: integer description: Total number of results example: 605627073905784686 format: int64 description: ListResultsResponseBody result type (default view) example: data: - createdAt: Et nihil eum aliquid. id: Corrupti adipisci. status: AVAILABLE, NOT_AVAILABLE or TIMEOUT updateAt: Eligendi numquam explicabo et et. - createdAt: Et nihil eum aliquid. id: Corrupti adipisci. status: AVAILABLE, NOT_AVAILABLE or TIMEOUT updateAt: Eligendi numquam explicabo et et. - createdAt: Et nihil eum aliquid. id: Corrupti adipisci. status: AVAILABLE, NOT_AVAILABLE or TIMEOUT updateAt: Eligendi numquam explicabo et et. limit: 7826705684134932775 page: 6711631781613832425 total: 933645411252342944 required: - data - page - limit - total