github.com/safedep/dry@v0.0.0-20241016050132-a15651f0548b/api/dry.yml (about)

     1  openapi: 3.0.2
     2  info:
     3    title: DRY API Model
     4    contact:
     5      name: SafeDep API
     6      url: 'https://safedep.io'
     7    description: |
     8      This is a dummy API for generating models for DRY. The objective is to re-use
     9      OpenAPI code gen tools to generate data models that can be used across projects
    10    version: 1.0.0
    11  servers:
    12    - url: 'https://{apiHost}/{apiBase}'
    13      variables:
    14        apiHost:
    15          default: api.safedep.io
    16        apiBase:
    17          default: /
    18  tags:
    19    - name: dry
    20      description: DRY tags
    21  paths:
    22    /:
    23      get:
    24        description: Dummy operation to reference models
    25        operationId: getDryModels
    26        tags:
    27          - dry
    28        responses:
    29          '200':
    30            description: Reference to Package Version
    31            content:
    32              application/json:
    33                schema:
    34                  $ref: '#/components/schemas/Dry'
    35  components:
    36    schemas:
    37      Dry:
    38        type: object
    39        description: References to other models
    40        properties:
    41          api_error:
    42            $ref: '#/components/schemas/ApiError'
    43          package_version:
    44            $ref: '#/components/schemas/PackageVersion'
    45          license:
    46            $ref: '#/components/schemas/License'
    47      ApiError:
    48        type: object
    49        properties:
    50          message:
    51            type: string
    52            description: A descriptive message about the error meant for developer consumption
    53          type:
    54            type: string
    55            description: An optional service or domain specific error group
    56            enum:
    57              - invalid_request
    58              - operation_failed
    59              - internal_error
    60          code:
    61            type: string
    62            description: An error code identifying the error
    63            enum:
    64              - api_guard_invalid_credentials
    65              - api_guard_rate_limit_exceeded
    66              - api_guard_unauthorized
    67              - api_guard_error
    68              - app_generic_error
    69              - app_package_version_not_found
    70          params:
    71            type: object
    72            description: Optional error specific attributes
    73            additionalProperties:
    74              type: object
    75              properties:
    76                key:
    77                  type: string
    78                value:
    79                  type: string
    80      PackageVersion:
    81        type: object
    82        required:
    83          - ecosystem
    84          - name
    85          - version
    86        properties:
    87          ecosystem:
    88            type: string
    89            description: The ecosystem where this package belongs to
    90            enum:
    91              - Maven
    92              - RubyGems
    93              - Go
    94              - npm
    95              - PyPI
    96              - Cargo
    97              - NuGet
    98              - Linux
    99              - Debian
   100              - Github Actions
   101          name:
   102            type: string
   103            description: The name of the package
   104          version:
   105            type: string
   106            description: The version of the package
   107      License:
   108        type: string
   109        description: License SPDX code
   110        enum:
   111          - 0BSD
   112          - AAL
   113          - Abstyles
   114          - Adobe-2006
   115          - Adobe-Glyph
   116          - ADSL
   117          - AFL-1.1
   118          - AFL-1.2
   119          - AFL-2.0
   120          - AFL-2.1
   121          - AFL-3.0
   122          - Afmparse
   123          - AGPL-1.0
   124          - AGPL-1.0-only
   125          - AGPL-1.0-or-later
   126          - AGPL-3.0
   127          - AGPL-3.0-only
   128          - AGPL-3.0-or-later
   129          - Aladdin
   130          - AMDPLPA
   131          - AML
   132          - AMPAS
   133          - ANTLR-PD
   134          - ANTLR-PD-fallback
   135          - Apache-1.0
   136          - Apache-1.1
   137          - Apache-2.0
   138          - APAFML
   139          - APL-1.0
   140          - App-s2p
   141          - APSL-1.0
   142          - APSL-1.1
   143          - APSL-1.2
   144          - APSL-2.0
   145          - Arphic-1999
   146          - Artistic-1.0
   147          - Artistic-1.0-cl8
   148          - Artistic-1.0-Perl
   149          - Artistic-2.0
   150          - Baekmuk
   151          - Bahyph
   152          - Barr
   153          - Beerware
   154          - Bitstream-Vera
   155          - BitTorrent-1.0
   156          - BitTorrent-1.1
   157          - blessing
   158          - BlueOak-1.0.0
   159          - Borceux
   160          - BSD-1-Clause
   161          - BSD-2-Clause
   162          - BSD-2-Clause-FreeBSD
   163          - BSD-2-Clause-NetBSD
   164          - BSD-2-Clause-Patent
   165          - BSD-2-Clause-Views
   166          - BSD-3-Clause
   167          - BSD-3-Clause-Attribution
   168          - BSD-3-Clause-Clear
   169          - BSD-3-Clause-LBNL
   170          - BSD-3-Clause-Modification
   171          - BSD-3-Clause-No-Military-License
   172          - BSD-3-Clause-No-Nuclear-License
   173          - BSD-3-Clause-No-Nuclear-License-2014
   174          - BSD-3-Clause-No-Nuclear-Warranty
   175          - BSD-3-Clause-Open-MPI
   176          - BSD-4-Clause
   177          - BSD-4-Clause-Shortened
   178          - BSD-4-Clause-UC
   179          - BSD-Protection
   180          - BSD-Source-Code
   181          - BSL-1.0
   182          - BUSL-1.1
   183          - bzip2-1.0.5
   184          - bzip2-1.0.6
   185          - C-UDA-1.0
   186          - CAL-1.0
   187          - CAL-1.0-Combined-Work-Exception
   188          - Caldera
   189          - CATOSL-1.1
   190          - CC-BY-1.0
   191          - CC-BY-2.0
   192          - CC-BY-2.5
   193          - CC-BY-2.5-AU
   194          - CC-BY-3.0
   195          - CC-BY-3.0-AT
   196          - CC-BY-3.0-DE
   197          - CC-BY-3.0-IGO
   198          - CC-BY-3.0-NL
   199          - CC-BY-3.0-US
   200          - CC-BY-4.0
   201          - CC-BY-NC-1.0
   202          - CC-BY-NC-2.0
   203          - CC-BY-NC-2.5
   204          - CC-BY-NC-3.0
   205          - CC-BY-NC-3.0-DE
   206          - CC-BY-NC-4.0
   207          - CC-BY-NC-ND-1.0
   208          - CC-BY-NC-ND-2.0
   209          - CC-BY-NC-ND-2.5
   210          - CC-BY-NC-ND-3.0
   211          - CC-BY-NC-ND-3.0-DE
   212          - CC-BY-NC-ND-3.0-IGO
   213          - CC-BY-NC-ND-4.0
   214          - CC-BY-NC-SA-1.0
   215          - CC-BY-NC-SA-2.0
   216          - CC-BY-NC-SA-2.0-FR
   217          - CC-BY-NC-SA-2.0-UK
   218          - CC-BY-NC-SA-2.5
   219          - CC-BY-NC-SA-3.0
   220          - CC-BY-NC-SA-3.0-DE
   221          - CC-BY-NC-SA-3.0-IGO
   222          - CC-BY-NC-SA-4.0
   223          - CC-BY-ND-1.0
   224          - CC-BY-ND-2.0
   225          - CC-BY-ND-2.5
   226          - CC-BY-ND-3.0
   227          - CC-BY-ND-3.0-DE
   228          - CC-BY-ND-4.0
   229          - CC-BY-SA-1.0
   230          - CC-BY-SA-2.0
   231          - CC-BY-SA-2.0-UK
   232          - CC-BY-SA-2.1-JP
   233          - CC-BY-SA-2.5
   234          - CC-BY-SA-3.0
   235          - CC-BY-SA-3.0-AT
   236          - CC-BY-SA-3.0-DE
   237          - CC-BY-SA-4.0
   238          - CC-PDDC
   239          - CC0-1.0
   240          - CDDL-1.0
   241          - CDDL-1.1
   242          - CDL-1.0
   243          - CDLA-Permissive-1.0
   244          - CDLA-Permissive-2.0
   245          - CDLA-Sharing-1.0
   246          - CECILL-1.0
   247          - CECILL-1.1
   248          - CECILL-2.0
   249          - CECILL-2.1
   250          - CECILL-B
   251          - CECILL-C
   252          - CERN-OHL-1.1
   253          - CERN-OHL-1.2
   254          - CERN-OHL-P-2.0
   255          - CERN-OHL-S-2.0
   256          - CERN-OHL-W-2.0
   257          - checkmk
   258          - ClArtistic
   259          - CNRI-Jython
   260          - CNRI-Python
   261          - CNRI-Python-GPL-Compatible
   262          - COIL-1.0
   263          - Community-Spec-1.0
   264          - Condor-1.1
   265          - copyleft-next-0.3.0
   266          - copyleft-next-0.3.1
   267          - CPAL-1.0
   268          - CPL-1.0
   269          - CPOL-1.02
   270          - Crossword
   271          - CrystalStacker
   272          - CUA-OPL-1.0
   273          - Cube
   274          - curl
   275          - D-FSL-1.0
   276          - diffmark
   277          - DL-DE-BY-2.0
   278          - DOC
   279          - Dotseqn
   280          - DRL-1.0
   281          - DSDP
   282          - dvipdfm
   283          - ECL-1.0
   284          - ECL-2.0
   285          - eCos-2.0
   286          - EFL-1.0
   287          - EFL-2.0
   288          - eGenix
   289          - Elastic-2.0
   290          - Entessa
   291          - EPICS
   292          - EPL-1.0
   293          - EPL-2.0
   294          - ErlPL-1.1
   295          - etalab-2.0
   296          - EUDatagrid
   297          - EUPL-1.0
   298          - EUPL-1.1
   299          - EUPL-1.2
   300          - Eurosym
   301          - Fair
   302          - FDK-AAC
   303          - Frameworx-1.0
   304          - FreeBSD-DOC
   305          - FreeImage
   306          - FSFAP
   307          - FSFUL
   308          - FSFULLR
   309          - FSFULLRWD
   310          - FTL
   311          - GD
   312          - GFDL-1.1
   313          - GFDL-1.1-invariants-only
   314          - GFDL-1.1-invariants-or-later
   315          - GFDL-1.1-no-invariants-only
   316          - GFDL-1.1-no-invariants-or-later
   317          - GFDL-1.1-only
   318          - GFDL-1.1-or-later
   319          - GFDL-1.2
   320          - GFDL-1.2-invariants-only
   321          - GFDL-1.2-invariants-or-later
   322          - GFDL-1.2-no-invariants-only
   323          - GFDL-1.2-no-invariants-or-later
   324          - GFDL-1.2-only
   325          - GFDL-1.2-or-later
   326          - GFDL-1.3
   327          - GFDL-1.3-invariants-only
   328          - GFDL-1.3-invariants-or-later
   329          - GFDL-1.3-no-invariants-only
   330          - GFDL-1.3-no-invariants-or-later
   331          - GFDL-1.3-only
   332          - GFDL-1.3-or-later
   333          - Giftware
   334          - GL2PS
   335          - Glide
   336          - Glulxe
   337          - GLWTPL
   338          - gnuplot
   339          - GPL-1.0
   340          - GPL-1.0+
   341          - GPL-1.0-only
   342          - GPL-1.0-or-later
   343          - GPL-2.0
   344          - GPL-2.0+
   345          - GPL-2.0-only
   346          - GPL-2.0-or-later
   347          - GPL-2.0-with-autoconf-exception
   348          - GPL-2.0-with-bison-exception
   349          - GPL-2.0-with-classpath-exception
   350          - GPL-2.0-with-font-exception
   351          - GPL-2.0-with-GCC-exception
   352          - GPL-3.0
   353          - GPL-3.0+
   354          - GPL-3.0-only
   355          - GPL-3.0-or-later
   356          - GPL-3.0-with-autoconf-exception
   357          - GPL-3.0-with-GCC-exception
   358          - gSOAP-1.3b
   359          - HaskellReport
   360          - Hippocratic-2.1
   361          - HPND
   362          - HPND-sell-variant
   363          - HTMLTIDY
   364          - IBM-pibs
   365          - ICU
   366          - IJG
   367          - ImageMagick
   368          - iMatix
   369          - Imlib2
   370          - Info-ZIP
   371          - Intel
   372          - Intel-ACPI
   373          - Interbase-1.0
   374          - IPA
   375          - IPL-1.0
   376          - ISC
   377          - Jam
   378          - JasPer-2.0
   379          - JPNIC
   380          - JSON
   381          - Knuth-CTAN
   382          - LAL-1.2
   383          - LAL-1.3
   384          - Latex2e
   385          - Leptonica
   386          - LGPL-2.0
   387          - LGPL-2.0+
   388          - LGPL-2.0-only
   389          - LGPL-2.0-or-later
   390          - LGPL-2.1
   391          - LGPL-2.1+
   392          - LGPL-2.1-only
   393          - LGPL-2.1-or-later
   394          - LGPL-3.0
   395          - LGPL-3.0+
   396          - LGPL-3.0-only
   397          - LGPL-3.0-or-later
   398          - LGPLLR
   399          - Libpng
   400          - libpng-2.0
   401          - libselinux-1.0
   402          - libtiff
   403          - libutil-David-Nugent
   404          - LiLiQ-P-1.1
   405          - LiLiQ-R-1.1
   406          - LiLiQ-Rplus-1.1
   407          - Linux-man-pages-copyleft
   408          - Linux-OpenIB
   409          - LOOP
   410          - LPL-1.0
   411          - LPL-1.02
   412          - LPPL-1.0
   413          - LPPL-1.1
   414          - LPPL-1.2
   415          - LPPL-1.3a
   416          - LPPL-1.3c
   417          - LZMA-SDK-9.11-to-9.20
   418          - LZMA-SDK-9.22
   419          - MakeIndex
   420          - Minpack
   421          - MirOS
   422          - MIT
   423          - MIT-0
   424          - MIT-advertising
   425          - MIT-CMU
   426          - MIT-enna
   427          - MIT-feh
   428          - MIT-Modern-Variant
   429          - MIT-open-group
   430          - MITNFA
   431          - Motosoto
   432          - mpi-permissive
   433          - mpich2
   434          - MPL-1.0
   435          - MPL-1.1
   436          - MPL-2.0
   437          - MPL-2.0-no-copyleft-exception
   438          - mplus
   439          - MS-LPL
   440          - MS-PL
   441          - MS-RL
   442          - MTLL
   443          - MulanPSL-1.0
   444          - MulanPSL-2.0
   445          - Multics
   446          - Mup
   447          - NAIST-2003
   448          - NASA-1.3
   449          - Naumen
   450          - NBPL-1.0
   451          - NCGL-UK-2.0
   452          - NCSA
   453          - Net-SNMP
   454          - NetCDF
   455          - Newsletr
   456          - NGPL
   457          - NICTA-1.0
   458          - NIST-PD
   459          - NIST-PD-fallback
   460          - NLOD-1.0
   461          - NLOD-2.0
   462          - NLPL
   463          - Nokia
   464          - NOSL
   465          - Noweb
   466          - NPL-1.0
   467          - NPL-1.1
   468          - NPOSL-3.0
   469          - NRL
   470          - NTP
   471          - NTP-0
   472          - Nunit
   473          - O-UDA-1.0
   474          - OCCT-PL
   475          - OCLC-2.0
   476          - ODbL-1.0
   477          - ODC-By-1.0
   478          - OFL-1.0
   479          - OFL-1.0-no-RFN
   480          - OFL-1.0-RFN
   481          - OFL-1.1
   482          - OFL-1.1-no-RFN
   483          - OFL-1.1-RFN
   484          - OGC-1.0
   485          - OGDL-Taiwan-1.0
   486          - OGL-Canada-2.0
   487          - OGL-UK-1.0
   488          - OGL-UK-2.0
   489          - OGL-UK-3.0
   490          - OGTSL
   491          - OLDAP-1.1
   492          - OLDAP-1.2
   493          - OLDAP-1.3
   494          - OLDAP-1.4
   495          - OLDAP-2.0
   496          - OLDAP-2.0.1
   497          - OLDAP-2.1
   498          - OLDAP-2.2
   499          - OLDAP-2.2.1
   500          - OLDAP-2.2.2
   501          - OLDAP-2.3
   502          - OLDAP-2.4
   503          - OLDAP-2.5
   504          - OLDAP-2.6
   505          - OLDAP-2.7
   506          - OLDAP-2.8
   507          - OML
   508          - OpenSSL
   509          - OPL-1.0
   510          - OPUBL-1.0
   511          - OSET-PL-2.1
   512          - OSL-1.0
   513          - OSL-1.1
   514          - OSL-2.0
   515          - OSL-2.1
   516          - OSL-3.0
   517          - Parity-6.0.0
   518          - Parity-7.0.0
   519          - PDDL-1.0
   520          - PHP-3.0
   521          - PHP-3.01
   522          - Plexus
   523          - PolyForm-Noncommercial-1.0.0
   524          - PolyForm-Small-Business-1.0.0
   525          - PostgreSQL
   526          - PSF-2.0
   527          - psfrag
   528          - psutils
   529          - Python-2.0
   530          - Python-2.0.1
   531          - Qhull
   532          - QPL-1.0
   533          - Rdisc
   534          - RHeCos-1.1
   535          - RPL-1.1
   536          - RPL-1.5
   537          - RPSL-1.0
   538          - RSA-MD
   539          - RSCPL
   540          - Ruby
   541          - SAX-PD
   542          - Saxpath
   543          - SCEA
   544          - SchemeReport
   545          - Sendmail
   546          - Sendmail-8.23
   547          - SGI-B-1.0
   548          - SGI-B-1.1
   549          - SGI-B-2.0
   550          - SHL-0.5
   551          - SHL-0.51
   552          - SimPL-2.0
   553          - SISSL
   554          - SISSL-1.2
   555          - Sleepycat
   556          - SMLNJ
   557          - SMPPL
   558          - SNIA
   559          - Spencer-86
   560          - Spencer-94
   561          - Spencer-99
   562          - SPL-1.0
   563          - SSH-OpenSSH
   564          - SSH-short
   565          - SSPL-1.0
   566          - StandardML-NJ
   567          - SugarCRM-1.1.3
   568          - SWL
   569          - Symlinks
   570          - TAPR-OHL-1.0
   571          - TCL
   572          - TCP-wrappers
   573          - TMate
   574          - TORQUE-1.1
   575          - TOSL
   576          - TU-Berlin-1.0
   577          - TU-Berlin-2.0
   578          - UCL-1.0
   579          - Unicode-DFS-2015
   580          - Unicode-DFS-2016
   581          - Unicode-TOU
   582          - Unlicense
   583          - UPL-1.0
   584          - Vim
   585          - VOSTROM
   586          - VSL-1.0
   587          - W3C
   588          - W3C-19980720
   589          - W3C-20150513
   590          - Watcom-1.0
   591          - Wsuipa
   592          - WTFPL
   593          - wxWindows
   594          - X11
   595          - X11-distribute-modifications-variant
   596          - Xerox
   597          - XFree86-1.1
   598          - xinetd
   599          - Xnet
   600          - xpp
   601          - XSkat
   602          - YPL-1.0
   603          - YPL-1.1
   604          - Zed
   605          - Zend-2.0
   606          - Zimbra-1.3
   607          - Zimbra-1.4
   608          - Zlib
   609          - zlib-acknowledgement
   610          - ZPL-1.1
   611          - ZPL-2.0
   612          - ZPL-2.1