[BUG] API not present in configuration file is still being deployed
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start by examining how configuration.d1.yaml is parsed and how the deployment process selects folders under apis. Compare the explicitly listed api1 entry with the unlisted api2 folder, including apiInformation.json and specification.json. Done means an API omitted or commented out of the configuration is not deployed while listed APIs still are.
Written by the indexing model from the issue text.
Description
Release version
v6.0.11
Describe the bug
As per documentation and #435, I was told that I should be able to prevent the deployment of an API by omitting the API from the configuration file.
However, this does not appear to work as I have an API currently commented in configuration code:
[...]
apis:
[...]
# - name: api2
# properties:
# serviceUrl: ""
# there is no dev env
but the API is being deployed whether I make a publish all artifacts or edit the specs and publish last commit...
I always deploy with configuration file as I have multiple environment, I am using different configuration files for each environment
Expected behavior
Only API defined explicitly in the configuration files are published. API that are commented should not be published.
Actual behavior
All API are deployed, all the time.
Reproduction Steps
configuration file configuration.d1.yaml:
---
apimServiceName: apimdev01
apis:
#APIs Begin
- name: api1
properties:
serviceUrl: "https://api1.example.net"
# - name: api2
# properties:
# serviceUrl: ""
# there is no dev env
folder structure:
- apis
- api1
- apiInformation.json
- specification.json
- api2
- apiInformation.json
- specification.json
- api1
- Dominant language
- C#
- Stars
- 448
- Forks
- 247
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Azure/apiops
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 3/5 1-2 days Newbie friendliness 70/100
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
nightscout/nocturne#1425 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
RayWangQvQ/BiliBiliToolPro#1137 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100