api_spec_oa3.yml

openapi: 3.0.1
info:
  title: PC WEB VALIDATOR
  description: This is a Go web interface validator for publiccode.yml files, it uses
    publiccode-parser-go. `publiccode.yml` is an international standard for describing
    public software. It is expected to be published in the root of open source repositories.
    This parser performs syntactic and semantic validation according to the official
    spec.
  termsOfService: https://github.com/italia/pc-web-validator
  x-api-id: 501E5354-2F69-4F0B-9BFB-6AA530430E84
  x-project: software
  contact:
    name: Developers Italia
    email: contatti@developers.italia.it
    url: https://developers.italia.it
  license:
    name: BSD 3-Clause
    url: https://github.com/sebbalex/pc-web-validator/blob/master/LICENSE
  version: 0.0.2
externalDocs:
  description: Find out more about Developers Italia
  url: https://developers.italia.it
servers:
  - url: https://publiccode-editor-test.developers.italia.it/
    description: Dev env
tags:
- name: public
  description: Everything about Publiccode
  externalDocs:
    description: Find out more
    url: https://github.com/italia/publiccode.yml
paths:
  /validate:
    post:
      tags:
        - public
      summary: Validate a PublicCode
      operationId: validate
      requestBody:
        description: Publiccode object that needs to be validated
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCode'
          application/x-yaml:
            schema:
              $ref: '#/components/schemas/PublicCode'
        required: true
      parameters:
        - name: disableNetwork
          in: query
          schema:
            type: boolean
            default: false
            example: false
          description: |
            By default this API resolves remote references and 
            validate the existence of asset files like logos and
            screenshots.
      responses:
        200:
          description: |-
            Validation Ok, return latest valid publiccode version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicCode'
            application/x-yaml:
              schema:
                $ref: '#/components/schemas/PublicCode'
        422:
          description: Validation failed
          content: 
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ValidationError'
components:
  schemas:
    ValidationError:
      properties:
        Key:
          type: string
        Reason:
          type: string
      required:
        - Key
        - Reason
    PublicCode:
      $ref: https://raw.githubusercontent.com/italia/publiccode-editor/master/src/app/editor_generator_schema.json