github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/resources/metadata/apiProviderList.yaml (about)

     1  metadata:
     2    name: apiProviderList
     3    description: Get a full List of all API providers from the API Portal
     4    longDescription: |
     5      With this step, you can get a list of all API providers from the API Portal using the OData API. Learn more about the API Management API for getting list of an API Providers [here](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/e26b3320cd534ae4bc743af8013a8abb.html).
     6  
     7  spec:
     8    inputs:
     9      secrets:
    10        - name: apimApiServiceKeyCredentialsId
    11          description: Jenkins secret text credential ID containing the service key to the API Management Runtime service instance of plan 'api'
    12          type: jenkins
    13      params:
    14        - name: apiServiceKey
    15          type: string
    16          description: Service key JSON string to access the API Management Runtime service instance of plan 'api'
    17          scope:
    18            - PARAMETERS
    19          mandatory: true
    20          secret: true
    21          resourceRef:
    22            - name: apimApiServiceKeyCredentialsId
    23              type: secret
    24              param: apiServiceKey
    25        - name: top
    26          type: int
    27          description: Show only the first n items.
    28          scope:
    29            - PARAMETERS
    30            - STAGES
    31            - STEPS
    32          mandatory: false
    33        - name: skip
    34          type: int
    35          description: Skip the first n items.
    36          scope:
    37            - PARAMETERS
    38            - STAGES
    39            - STEPS
    40          mandatory: false
    41        - name: filter
    42          type: string
    43          description: Filter items by property values.
    44          scope:
    45            - PARAMETERS
    46            - STAGES
    47            - STEPS
    48          mandatory: false
    49        - name: count
    50          type: bool
    51          description: Include count of items.
    52          scope:
    53            - PARAMETERS
    54            - STAGES
    55            - STEPS
    56          mandatory: false
    57        - name: search
    58          type: string
    59          description: Search items by search phrases.
    60          scope:
    61            - PARAMETERS
    62            - STAGES
    63            - STEPS
    64          mandatory: false
    65        - name: orderby
    66          type: string
    67          description: Order by property values.
    68          scope:
    69            - PARAMETERS
    70            - STAGES
    71            - STEPS
    72          mandatory: false
    73        - name: select
    74          type: string
    75          description: Select properties to be returned.
    76          scope:
    77            - PARAMETERS
    78            - STAGES
    79            - STEPS
    80          mandatory: false
    81        - name: expand
    82          type: string
    83          description: Expand related entities.
    84          scope:
    85            - PARAMETERS
    86            - STAGES
    87            - STEPS
    88          mandatory: false
    89    outputs:
    90      resources:
    91        - name: commonPipelineEnvironment
    92          type: piperEnvironment
    93          params:
    94            - name: custom/apiProviderList