OpenAPI schema

GET {{baseUrl}}/schema
RESPONSES

status: OK
&quot;openapi: &#39;3.0.0&#39;\ninfo:\n  version: &#39;1.2.9&#39;\n  title: &#39;A(i)ppealing Companies&#39;\n  description: |-\n\n    API to create appealing images of company products made of chocolate, gold, plush or lego - generated by AI\n\n    ## Motivation\n\n    There are some amazing, visually appealing company products made of chocolate or lego\n\n    \u003cimg src=\&quot;https://user-images.githubusercontent.com/1872314/208320977-06e18d27-4938-4be3-ab9d-8b2ffc2c85e1.png\&quot; alt=\&quot;Lexus%20made%20of%20chocolate\&quot; width=\&quot;197\&quot;\u003e\n\n    \u003cimg src=\&quot;https://user-images.githubusercontent.com/1872314/208321054-130afbaa-f7db-453e-8db1-114ebce97f4e.png\&quot; alt=\&quot;Flowers%20made%20of%20Lego\&quot; width=\&quot;239\&quot;\u003e\n\n    Inspired by the image and text generation capabilities of [OpenAI](https://www.postman.com/devrel/workspace/openai/documentation/13183464-90abb798-cb85-43cb-ba3a-ae7941e968da), this API generates images of the products, companies are most known for, and turns them into gold, chocolate, lego or any other material.\n\n    #### Volkswagen / Porsche\n\n    \u003cimg src=\&quot;https://user-images.githubusercontent.com/1872314/208321137-0ab3cdb9-a2d2-47ad-9f9e-172188a848d5.png\&quot; alt=\&quot;Porsche%20911%20made%20of%20Lego\&quot; width=\&quot;200\&quot;\u003e\n\n    \u003cimg src=\&quot;https://user-images.githubusercontent.com/1872314/208321209-9a82e2b5-47aa-4d9d-a267-1659e2964b0b.png\&quot; alt=\&quot;VW%20caravan%20made%20of%20Lego\&quot; width=\&quot;200\&quot;\u003e\n\n    #### Allianz\n\n    \u003cimg src=\&quot;https://user-images.githubusercontent.com/1872314/208321233-117ba82b-1c3b-4bab-860a-3fc94b9df407.png\&quot; alt=\&quot;Allianz%20Arena%20made%20of%20chocolate\&quot; width=\&quot;200\&quot;\u003e\n\n    \u003cimg src=\&quot;https://user-images.githubusercontent.com/1872314/208321469-9a3d2c0a-ced0-4568-b61e-45f5e46f4524.png\&quot; alt=\&quot;Allianz%20Arena%20made%20of%20Lego\&quot; width=\&quot;200\&quot;\u003e\n\n    ### Mercedes-Benz\n\n    \u003cimg src=\&quot;https://user-images.githubusercontent.com/1872314/208321375-19d9198a-858d-4fc9-b95c-6a31fe58096a.png\&quot; alt=\&quot;C-class%20made%20of%20gold\&quot; width=\&quot;200\&quot;\u003e\n\n    \u003cimg src=\&quot;https://user-images.githubusercontent.com/1872314/208321413-806d2afc-d3fb-4660-9299-7ca86be90e2f.png\&quot; alt=\&quot;C-class%20made%20of%20gold%20(second%20run)\&quot; width=\&quot;200\&quot;\u003e\n\nservers:\n  - url: https://aippealing-companies.herokuapp.com\n    description: Production Server\n  - url: https://aippealing-companies-staging.herokuapp.com\n    description: Staging Server\n  - url: http://localhost:3000\n    description: Local test bed\npaths:\n  # get individual company\n  /companies/{companyId}:\n    get:\n      summary: Get company\n      description: Get company and its a(i)ppealing associations\n      operationId: getCompany\n      tags:\n        - companies\n      parameters:\n        - name: companyId\n          in: path\n          description: Company ID\n          required: true\n          schema:\n            type: string\n          example: daimler\n        - name: material\n          in: query\n          description: Material to use for the product\n          required: false\n          schema:\n            type: string\n            enum:\n              - chocolate\n              - lego\n              - gold\n              - plush\n              - platin\n            default: lego\n          example: plush\n        - name: mode\n          in: query\n          description: Mode to use for the product, exact and fuzzy operate on the curated list of products, ai uses AI to generate all aspects of the product\n          required: false\n          schema:\n            type: string\n            enum:\n              - exact\n              - ai\n              - fuzzy\n            default: fuzzy\n          example: fuzzy\n          \n      responses:\n        &#39;200&#39;:\n          description: OK\n          content:\n            application/json:\n                schema:\n                    $ref: &#39;#/components/schemas/Company&#39;\n                example:\n                  id: yousendmeflowers\n                  name: &#39;Fleurop / yousendmeflowers / main&#39;\n                  city: &#39;{{$randomCity}}&#39;\n                  motto: &#39;{{$randomCatchPhrase}}&#39;\n                  description: &#39;Fleurop is a flower delivery service with a network of florists in 140 countries. YouSendMeFlowers is a similar service in the US. Main is a flower delivery service in the Netherlands.&#39;\n                  associations:\n                    - name: &#39;Flowers&#39;\n                      type: &#39;product&#39;\n                      material: &#39;lego&#39;\n                      url: &#39;https://user-images.githubusercontent.com/1872314/208254526-fe40f349-5456-4549-b72d-e49fe341f8e7.png&#39;\n        &#39;404&#39;:\n          description: Not Found\n          content:\n            application/json:\n              schema:\n                $ref: &#39;#/components/schemas/Error&#39;\n        &#39;500&#39;:\n          description: Internal Server Error\n          content:\n            application/json:\n              schema:\n                $ref: &#39;#/components/schemas/Error&#39;\n        &#39;401&#39;:\n          description: Unauthorized\n          content:\n            application/json:\n              schema:\n                $ref: &#39;#/components/schemas/Error&#39;\n  /companies:\n    get:\n      summary: List all companies\n      description: List all companies and their a(i)ppealing associations\n      operationId: listCompanies\n      tags:\n        - companies\n      responses:\n        &#39;200&#39;:\n          description: OK\n          content:\n            application/json:\n              schema:\n                $ref: &#39;#/components/schemas/Companies&#39;\n              example:\n                - id: yousendmeflowers\n                  name: &#39;Fleurop / yousendmeflowers / main&#39;\n                  city: &#39;{{$randomCity}}&#39;\n                  motto: &#39;{{$randomCatchPhrase}}&#39;\n                  description: &#39;Fleurop is a flower delivery service with a network of florists in 140 countries. YouSendMeFlowers is a similar service in the US. Main is a flower delivery service in the Netherlands.&#39;\n                  associations:\n                    - name: &#39;Flowers&#39;\n                      type: &#39;product&#39;\n                      material: &#39;lego&#39;\n                      url: &#39;https://user-images.githubusercontent.com/1872314/208254526-fe40f349-5456-4549-b72d-e49fe341f8e7.png&#39;\n                - id: \&quot;volkswagen\&quot;\n                  name: &#39;Volkswagen&#39;\n                  description: &#39;Volkswagen AG is a German multinational automotive manufacturing company headquartered in Wolfsburg, Lower Saxony, Germany.&#39;\n                  city: &#39;Wolfsburg&#39;\n                  motto: &#39;Das Auto&#39;\n                  associations:\n                    - name: &#39;VW Caravan&#39;\n                      type: &#39;product&#39;\n                      material: &#39;lego&#39;\n                      url: &#39;https://user-images.githubusercontent.com/1872314/208270572-17d0d771-17d5-4e95-ab1c-6ebc86432bb9.png&#39;\n                    - name: &#39;Porsche 911&#39;\n                      type: &#39;product&#39;\n                      material: &#39;lego&#39;\n                      url: &#39;https://user-images.githubusercontent.com/1872314/208270526-6b8dd152-674e-4496-835f-671882e70d1b.png&#39;\n                - id: &#39;lexus&#39;\n                  name: &#39;Lexus&#39;\n                  city: &#39;Toyota&#39;\n                  motto: &#39;The Pursuit of Perfection&#39;\n                  description: \&quot;Lexus is the luxury vehicle division of the Japanese automaker Toyota. The Lexus brand is marketed in more than 70 countries and territories worldwide and has become Japan&#39;s largest-selling make of premium cars.\&quot;\n                  associations:\n                    - name: &#39;Lexus UX&#39;\n                      type: &#39;product&#39;\n                      material: &#39;chocolate&#39;\n                      url: &#39;https://user-images.githubusercontent.com/1872314/208254307-d1971475-31aa-4c10-ac8d-7b907579438d.png&#39;\n                - id: &#39;allianz&#39;\n                  name: &#39;Allianz&#39;\n                  city: &#39;Munich&#39;\n                  motto: &#39;Together. Stronger.&#39;\n                  description: &#39;Allianz SE is a German multinational financial services company headquartered in Munich, Bavaria. It is the largest insurance company in the world by revenue.&#39;\n                  associations:\n                    - name: &#39;Allianz Arena&#39;\n                      type: &#39;product&#39;\n                      material: &#39;chocolate&#39;\n                      url: \&quot;https://user-images.githubusercontent.com/1872314/208270631-87b3c79c-c6e8-47dd-9cf2-52451989b83b.png\&quot;\n                - id: \&quot;becks\&quot;\n                  name: \&quot;Becks\&quot;\n                  city: \&quot;Bremen\&quot;\n                  motto: \&quot;Make it your Beck&#39;s\&quot;\n                  description: \&quot;German brewing company founded in 1873\&quot;\n                  associations:\n                    - name: \&quot;beer\&quot;\n                      type: \&quot;product\&quot;\n                      url: \&quot;https://user-images.githubusercontent.com/1872314/209992238-fca4ddbe-3f11-4d92-a4e9-de568d9538b3.png\&quot;\n                      material: \&quot;gold\&quot;\n                - id: \&quot;daimler\&quot;\n                  name: \&quot;Daimler\&quot;\n                  city: \&quot;Stuttgart, Germany\&quot;\n                  motto: \&quot;The Best or Nothing\&quot;\n                  description: \&quot;a German multinational automotive corporation\&quot;\n                  associations:\n                    - name: \&quot;Mercedes e-class\&quot;\n                      type: \&quot;product\&quot;\n                      url: \&quot;https://user-images.githubusercontent.com/1872314/210013865-1a047e2b-f44a-4a1b-a0cc-dbbdce7ed724.png\&quot;\n                      material: \&quot;plush\&quot;\n                \n        &#39;400&#39;:\n          description: Bad Request\n          content:\n            application/json:\n              schema:\n                $ref: &#39;#/components/schemas/Error&#39;\n        &#39;401&#39;:\n          description: Unauthorized\n          content:\n            application/json:\n              schema:\n                $ref: &#39;#/components/schemas/Error&#39;\n        &#39;500&#39;:\n          description: Internal Server Error\n          content:\n            application/json:\n              schema:\n                $ref: &#39;#/components/schemas/Error&#39;\ncomponents:\n  schemas:\n    Companies:\n      type: array   \n      items:\n        $ref: &#39;#/components/schemas/Company&#39;\n    Company:\n      type: object\n      properties:\n        id:\n          type: string\n          description: The unique identifier of the company\n          example: yousendmeflowers\n        name:\n          type: string\n          description: The name of the company\n          example: \&quot;YouSendMeFlowers / Fleurop\&quot;\n        description:\n          type: string\n          description: The description of the company\n          example: &#39;Fleurop is a flower delivery service with a network of florists in 140 countries. YouSendMeFlowers is a similar service in the US.&#39;\n        city:\n          type: string\n          description: City associated with company\n          example: &#39;Amsterdam&#39;\n        motto:\n          type: string\n          description: Motto associated with company\n          example: &#39;Flowers across the globe&#39;\n        associations:\n          type: array\n          items:\n            $ref: &#39;#/components/schemas/Association&#39;\n      required:\n        - name\n      example:\n        name: &#39;Lexus&#39;\n        description: \&quot;Lexus is the luxury vehicle division of the Japanese automaker Toyota. The Lexus brand is marketed in more than 70 countries and territories worldwide and has become Japan&#39;s largest-selling make of premium cars.\&quot;\n        city: &#39;Toyota City&#39;\n        motto: &#39;The Pursuit of Perfection&#39;\n        associations:\n        - name: &#39;Lexus UX&#39;\n          material: &#39;lego&#39;\n          type: &#39;product&#39;\n          url: &#39;https://user-images.githubusercontent.com/1872314/208254307-d1971475-31aa-4c10-ac8d-7b907579438d.png&#39;    \n   \n    Association:\n      type: object\n      required:\n        - name\n      properties:\n        name:\n          type: string\n          description: The name of the association\n          example: \&quot;Flowers\&quot;\n        type:\n          type: string\n          description: The type of the association\n          enum:\n            - service\n            - product\n          example: product\n        description:\n          type: string\n          description: The description of the association\n          example: \&quot;Flowers made of lego\&quot;\n        material:\n          type: string\n          description: The material of the association\n          example: lego\n        url:\n          type: string\n          format: uri\n          description: The a(i)ppealing image generated with the association \n          example: &#39;https://user-images.githubusercontent.com/1872314/208254526-fe40f349-5456-4549-b72d-e49fe341f8e7.png&#39;\n      example:\n        name: &#39;Lexus UX&#39;\n        material: &#39;lego&#39;\n        type: &#39;product&#39;\n        url: &#39;https://user-images.githubusercontent.com/1872314/208254307-d1971475-31aa-4c10-ac8d-7b907579438d.png&#39;\n    Error:\n      type: object\n      required:\n        - message\n      properties:\n        message:\n          description: A human readable error message\n          type: string\n          example: &#39;Company not found&#39;\n  securitySchemes:\n    ApiKey:\n      type: apiKey\n      in: header\n      name: X-Api-Key\n      description: API key for this API is an OpenAI compatible key. You can get your key at https://beta.openai.com/\nsecurity:\n  - ApiKey: []\n&quot;